home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / alGetEventQueueFD.z / alGetEventQueueFD
Encoding:
Text File  |  1998-10-20  |  4.1 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD((((3333ddddmmmm))))                                  aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetEventQueueFD - get the file descriptor for an audio event queue
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      iiiinnnntttt aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD((((AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee eeeevvvveeeennnnttttqqqq))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _e_v_e_n_t_q   expects the AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee structure whose file descriptor you
  18.               desire.  This structure is the returned value of an
  19.               aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) call.
  20.  
  21. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD(((()))) returns a file descriptor that you can use to
  23.      construct the arguments to a sssseeeelllleeeecccctttt((((2222))))  or ppppoooollllllll((((2222)))) call.
  24.  
  25.      These calls are used when you want to block a process until a queue
  26.      receives an audio event (see aaaallllSSSSeeeelllleeeeccccttttEEEEvvvveeeennnnttttssss((((3333ddddmmmm))))).  At that time,
  27.      sssseeeelllleeeecccctttt((((2222)))) and ppppoooollllllll((((2222)))) return, and your code can retrieve the event
  28.      information through calls to aaaallllNNNNeeeexxxxttttEEEEvvvveeeennnntttt((((3333ddddmmmm)))) or aaaallllCCCChhhheeeecccckkkkEEEEvvvveeeennnntttt((((3333ddddmmmm)))).
  29.      NOTE: aaaallllNNNNeeeexxxxttttEEEEvvvveeeennnntttt((((3333ddddmmmm)))) will block if passed an event queue that is empty.
  30.  
  31.      When using sssseeeelllleeeecccctttt((((2222)))), an event queue file descriptor is used in a read
  32.      fdset.
  33.  
  34.      When using ppppoooollllllll((((2222)))), an event queue file descriptor is used with the
  35.      POLLIN event flag.
  36.  
  37. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  38.      Upon successful completion, aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD returns a valid file
  39.      descriptor. Otherwise, aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD returns -1 and sets an error
  40.      number which can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  41.  
  42.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD can fail for the following reason:
  43.  
  44.      AAAALLLL____BBBBAAAADDDD____IIIINNNNVVVVAAAALLLLIIIIDDDD____EEEEVVVVEEEENNNNTTTTQQQQ   _e_v_e_n_t_q is either invalid or null.
  45.  
  46. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  47.      alSelectEvents(3dm), alOpenEventQueue(3dm), alNextEvent(3dm),
  48.      alCheckEvent(3dm), select(2), poll(2), oserror(3C)
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.